/*
 * Copyright (c) 2008 Plausible Labs Cooperative, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of any contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

// Forward-declarations
@class PLEntityManager;
@class PLSqlBuilder;

@interface PLEntitySession : NSObject {
@private
    /** Our parent entity manager. */
    PLEntityManager *_entityManager;

    /** The backing database connection */
    NSObject<PLDatabase> *_database;
    
    /** The SQL dialect */
    PLEntityDialect *_sqlDialect;

    /** The SQL statement builder */
    PLSqlBuilder *_sqlBuilder;

    /** Marks the current transaction state (in transaction == YES) */
    BOOL _inTransaction;
}

/* Sessions should only be created by the PLEntityManager */
#if PL_DB_PRIVATE
- (id) initWithEntityManager: (PLEntityManager *) entityManager error: (NSError **) error;
#endif

- (BOOL) begin;
- (BOOL) beginAndReturnError: (NSError **) error;


- (BOOL) commit;
- (BOOL) commitAndReturnError: (NSError **) error;


- (BOOL) rollback;
- (BOOL) rollbackAndReturnError: (NSError **) error;

- (BOOL) inTransaction;

- (BOOL) insertEntity: (PLEntity *) entity;
- (BOOL) insertEntity: (PLEntity *) entity error: (NSError **) error;

- (BOOL) deleteEntity: (PLEntity *) entity;
- (BOOL) deleteEntity: (PLEntity *) entity error: (NSError **) error;

- (void) close;

@end
